Skip to content

feat(sistent): add Table component documentation#7610

Open
Sohamsig wants to merge 14 commits intolayer5io:masterfrom
Sohamsig:sistent-table-docs
Open

feat(sistent): add Table component documentation#7610
Sohamsig wants to merge 14 commits intolayer5io:masterfrom
Sohamsig:sistent-table-docs

Conversation

@Sohamsig
Copy link
Copy Markdown

@Sohamsig Sohamsig commented Apr 9, 2026

This PR adds documentation for the Table component in Sistent.

Added:

  • index.mdx
  • guidance.mdx
  • code.mdx

Also updated navigation for Table component.

Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
@Sohamsig Sohamsig force-pushed the sistent-table-docs branch from f51f3b9 to 9b7a07a Compare April 9, 2026 17:32
@Sohamsig
Copy link
Copy Markdown
Author

Sohamsig commented Apr 10, 2026

@rishiraj38 Hi, I’ve completed the changes for this issue.
Deploy preview failed due to fork permissions, but all checks passed.
Could you please review when you get a chance? Thanks!

Copy link
Copy Markdown
Member

@rishiraj38 rishiraj38 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please refer to the other components present there; this, in my opinion, is not the correct implementation.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

where is the code ?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This navigation is also incorrect.

@@ -0,0 +1,18 @@
---
title: Table
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn’t right; we have more fields here.

@rishiraj38 rishiraj38 removed the request for review from Rajesh-Nagarajan-11 April 10, 2026 19:09
@rishiraj38
Copy link
Copy Markdown
Member

@Sohamsig, will you be able to do this? I see you’re a first-time contributor so it might be a bit overwhelming.

Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
@Sohamsig Sohamsig force-pushed the sistent-table-docs branch from 2fee297 to 582b087 Compare April 11, 2026 05:35
@Sohamsig
Copy link
Copy Markdown
Author

@rishiraj38 Yes, I've already addressed the comments and updated the PR.
Please let me know if anything else needs to be fixed. Thanks!

@Sohamsig Sohamsig requested a review from rishiraj38 April 11, 2026 05:43
Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
@Sohamsig
Copy link
Copy Markdown
Author

Sohamsig commented Apr 11, 2026

@rishiraj38 Hi 👋
I’ve pushed the changes to fix the import issue, but the CI build is still failing with:
Can't resolve @sistent/components
I updated src/collections/sistent/components/table/index.mdx to use the local ConformanceTest-Table import, but it seems there may still be another reference or the build is expecting a different setup.

Could you please guide me on whether @sistent/components should be installed/linked, or if there are any other files I might have missed?

Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
@Sohamsig Sohamsig force-pushed the sistent-table-docs branch from daf7d3f to 00eba17 Compare April 12, 2026 08:38
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this file; we no longer need it.

@rishiraj38
Copy link
Copy Markdown
Member

@Sohamsig, please check for build failures.

Sohamsig and others added 3 commits April 13, 2026 18:01
Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
Signed-off-by: Soham Babrekar <soham.babrekar@gmail.com>
Copy link
Copy Markdown
Member

@rishiraj38 rishiraj38 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The build fails because ThemeWrapper and CodeBlock are being manually imported on lines 8 and 9 using an incorrect path. Since these are global components in our MDX setup simply removing those import lines will resolve the build error.

Copy link
Copy Markdown
Member

@rishiraj38 rishiraj38 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Fix Build Error: In code.mdx, please remove the manual import ThemeWrapper and CodeBlock lines. These components are already provided globally by our MDX template, and the manual imports are currently breaking the CI build.
  • Use Sistent Components: For the examples in code.mdx and the overview in index.mdx, please use the official sub-components from @sistent/sistent (e.g., Table, TableBody, TableCell, TableContainer, TableHead, and TableRow) instead of raw HTML tags or the specialized ConformanceTest-Table.
  • Follow Documentation Standards: As mentioned in the issue, the documentation should match the style and depth of the Button component. This includes wrapping live demos in and using /
  • for layout consistency.
  • Demonstrate States: The issue explicitly asks for examples of various states (sortable, selectable rows, paginated). Using the @sistent/sistent components mentioned above will allow you to correctly showcase these features.
  • Could you also flesh out the Guidance section with some best practices and stylistic tips to match our other core documentation? Let me know if you have any questions!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants